<?php
/**
 * Plugin documentation
 * 
 * @package Bd Gallery
 * @author Bebliuc George Cristian
 * @author Gianfranco Liporace
 * @copyright 2008-2010
 * @version 1.3
 * @access public
 * @permisions Modify, Redistribute but leave the credits alive :P
 * @use Noncommercial, for commercial use, please contact me at bebliuc.george@gmail.com, it's for free, but I need to know
 *
 */
?>

<h1>Bd Gallery Documentation</h1>
<p>Welcome to the Bd Gallery Documentation page. Here are some little tips of
    using this plugin.</p>
<h3>Usage</h3>
<p>After you have installed this plugin, create a new page and put its name
    in the setting option "Gallery path"; after that, you can access the gallery page on the
    frontend through the address: <code>http://&lt;mysiteaddress&gt;/&lt;gallery_path&gt;</code>.<br />
    You can also display a specific album in this way:
    <code>http://&lt;mysiteaddress&gt;/&lt;gallery_path&gt;/&lt;gallery_id&gt;</code>.
    You can find the gallery id in the gallery admin page.</p>
<p> Tag support for albums is added in this release. When creating a new album multiple tags can be added
    by separating them with a comma. After that, tagged albums can be showed in the frontend
    using this URL syntax:<br />
    <code>http://&lt;mysiteaddress&gt;/&lt;gallery_path&gt;/tags/&lt;tag_list_separated_by_comma&gt;</code></p>
<p>If you are going to use a script like ShadowBox, Slimbox or popup from the "Script"
    Settings, you have to place this between your &lt;head&gt; and &lt;/head&gt; tags :
    <code>&lt;?php gallery_js(); ?&gt;</code></p>
<p>As you can see, in the same section "Gallery settings", there is a Images
    Folder field. What do you have to insert there? That is the folder where all
    the images are uploaded. So, you have to create a new folder
    (or use an existing one) . You have to create it in the
    <font color="red">public</font> folder. Then insert the name of the new
    created folder in the Images folder field. </p>
<p>
    A <code>gal_frontend.css</code> style sheet file is provided (look into gallery/css folder), modify it as you like
    and include it inside your theme and inside a layout module.</p>
<p>For the gallery to work, these are the necessary setting.</p>
<h3>Random image</h3>
<p>Two public function are provided to display a random image inside a page.<br />
    <code>random_photo_fx()</code> display a thumbnail of a random photo picked from the
    albums which, if clicked, display the larger one using the javascript library
    configured into the settings page.<br />
    <code>random_photo_nofx()</code> display a plain image picked randomly from the albums.
    Usage:<br />
    <code>
    &lt;?php random_photo_fx(); ?&gt; <br />
    &lt;?php random_photo_nofx(); ?&gt;
    </code>